Enviar Documentos para Analises retorno de Score

Para a melhor performance da validação automática em relação a qualidade de imagem do documento/selfie, os parâmetros de tamanho da imagem devem seguir os requisistos:

• tamanho mínimo: 100KB
• tamanho máximo: 4.5MB
• extensões: JPEG, PNG, PDF

Requisição

POST [Url Ambiente]/Score/Enviar

Header

Identificador	Valor
Content-type	application/json
Accept	application/json
Authorization	Bearer [Valor do Token retornado na Autenticação]

Body

Parâmetro	Descrição	Tipo	Exemplos
Chave	Campo para identificação da analise	String	"ChaveDefinidaPeloCliente"
ImagemFrente	Imagem da frente do documento	Base64	Base64
ImagemVerso	Imagem do verso do documento	Base64	Base64
ImagemSelfie	Imagem da selfie	Base64	Base64
ImagemQrCode	Imagem do QrCode para documentos digitais	Base64	Base64
CPF	CPF para validação em bases cadastrais	String	"000000000000"
WebHook	Configurações para envio de webhook especificas da analise	Objeto	{ "Url": "https://meuwebhook.com.br/api/receber", "Headers": { "token" : "sf8sd9f89ds7f9dsf9ds79f7ds" } }
Url	Endereço de envio do resultado da analise	String	"https://meuwebhook.com.br/api/receber"
Headers	Configurações de cabeçalhos para envio de webhook especificas da analise	Objeto	{ "token" : "sf8sd9f89ds7f9dsf9ds79f7ds", "Content-Type" : "application/json" }

Exemplo

{
  "Chave": "string",
  "ImagemFrente": "string",
  "ImagemVerso": "string",
  "ImagemSelfie": "string",
  "ImagemQrCode": "string",
  "CPF": "string",
  "WebHook": {
    "Url": "https://meuwebhook.com.br/api/receber",
    "Headers": {
      "Content-Type": "application/json",
      "token": "sf8sd9f89ds7f9dsf9ds79f7ds"
    }
  }
}

Status Code 200

Retorno de sucesso.

Parâmetro	Descrição	Tipo	Exemplos
Status	Status da requisição	OK = 0, ERRO = 1	0
Mensagens	Descrição dos erros	String[]	["SUCESSO"]

Exemplo

{
  "Status": 0,
  "Mensagens": [
    "SUCESSO"
  ]
}

Status Code 401

Usuário/Senha inválidos.

Parâmetro	Descrição	Tipo	Exemplos
Status	Status da requisição	OK = 0, ERRO = 1	1
Mensagens	Descrição dos erros	String[]	"Mensagens": []

Status Code 404

Erro 404 - Url não encontrado

O erro 404 é exibido quando um endpoint especificado pelo usuário não é encontrado na API. Isso pode ocorrer quando o usuário digitou um URL incorreto ou quando o endpoint não está mais disponível.

Status Code 500

Erro não tratado pelo sistema.

Parâmetro	Descrição	Tipo	Exemplos
Status	Status da requisição	OK/ERRO	ERRO
Mensagens	Descrição dos erros	String[]	"Mensagens": []

Exemplo

{
  "Status": "OK",
  "Mensagens": [
    "string"
  ]
}